Update realtime setting for the Audience

Request

Security

TdApikeyAuth

Path

audienceIdinteger, (int64)required

Audience ID

Bodyapplication/jsonrequired

parameters to edit the realtime setting

keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required

eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required

batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required

extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

curl -i -X PATCH \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_setting' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "keyColumns": [
      {
        "name": "string",
        "validRegexp": "string",
        "invalidTexts": [
          "string"
        ],
        "internal": true
      }
    ],
    "eventTables": [
      {
        "database": "string",
        "table": "string"
      }
    ],
    "batchAttributes": [
      {
        "column": "string",
        "name": "string"
      }
    ],
    "extLookupKey": "string"
  }'

Responses

Returns the realtime setting for the Audience

Bodyapplication/json

idstring[1-9][0-9]*

keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required

eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required

batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required

extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

statusstringrequired

Enum:"initialized""updating""ok""inconsistent""not_initialized"

statusDetailedobject or nullrequired

Detailed status information from realtime-api

Response

{
  "id": "string",
  "keyColumns": [
    { … }
  ],
  "eventTables": [
    { … }
  ],
  "batchAttributes": [
    { … }
  ],
  "extLookupKey": "string",
  "status": "initialized",
  "statusDetailed": {}
}